Skip to content

Conversation

@bouweandela
Copy link
Member

@bouweandela bouweandela commented Nov 8, 2022

Description

There is a mistake in the docstring of esmvalcore.esgf.find_files. The function is called search in the docstring, where it should be find_files. This pull request corrects the issue.

Link to documentation: https://esmvaltool--1784.org.readthedocs.build/projects/ESMValCore/en/1784/api/esmvalcore.esgf.html#esmvalcore.esgf.find_files


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number pull requests:

@bouweandela bouweandela added the documentation Improvements or additions to documentation label Nov 8, 2022
@codecov
Copy link

codecov bot commented Nov 8, 2022

Codecov Report

Merging #1784 (109d159) into main (3666bfa) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1784   +/-   ##
=======================================
  Coverage   91.11%   91.11%           
=======================================
  Files         203      203           
  Lines       10908    10908           
=======================================
  Hits         9939     9939           
  Misses        969      969           
Impacted Files Coverage Δ
esmvalcore/esgf/_download.py 100.00% <ø> (ø)
esmvalcore/esgf/_search.py 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@bouweandela bouweandela marked this pull request as ready for review November 8, 2022 14:33
Copy link
Contributor

@schlunma schlunma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks Bouwe!

@bouweandela
Copy link
Member Author

Thanks for the review @schlunma! @ESMValGroup/technical-lead-development-team Could one of you please do a final check and then merge?

@valeriupredoi
Copy link
Contributor

I shallz!

Copy link
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noice, cheers guys!

@valeriupredoi valeriupredoi merged commit b880462 into main Nov 10, 2022
@valeriupredoi valeriupredoi deleted the esgf-doc-update branch November 10, 2022 13:53
@valeriupredoi
Copy link
Contributor

@bouweandela @schlunma and myself get the prize for the best PR that causes all tests to fail after merge, when only docs changed 🤣 🤣 https://github.com/ESMValGroup/ESMValCore/actions/runs/3437374771/jobs/5732045770

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants